home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XIfEvent.z / XIfEvent
Encoding:
Text File  |  1998-10-30  |  4.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXIIIIffffEEEEvvvveeeennnntttt((((3333XXXX11111111))))     XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))      XXXXIIIIffffEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XIfEvent, XCheckIfEvent, XPeekIfEvent - check the event
  10.           queue with a predicate procedure
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           XIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t__r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 XEvent *_e_v_e_n_t__r_e_t_u_r_n;
  16.                 Bool (*_p_r_e_d_i_c_a_t_e)();
  17.                 XPointer _a_r_g;
  18.  
  19.           Bool XCheckIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t__r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
  20.                 Display *_d_i_s_p_l_a_y;
  21.                 XEvent *_e_v_e_n_t__r_e_t_u_r_n;
  22.                 Bool (*_p_r_e_d_i_c_a_t_e)();
  23.                 XPointer _a_r_g;
  24.  
  25.           XPeekIfEvent(_d_i_s_p_l_a_y, _e_v_e_n_t__r_e_t_u_r_n, _p_r_e_d_i_c_a_t_e, _a_r_g)
  26.                 Display *_d_i_s_p_l_a_y;
  27.                 XEvent *_e_v_e_n_t__r_e_t_u_r_n;
  28.                 Bool (*_p_r_e_d_i_c_a_t_e)();
  29.                 XPointer _a_r_g;
  30.  
  31.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  32.           _a_r_g       Specifies the user-supplied argument that will be
  33.                     passed to the predicate procedure.
  34.  
  35.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  36.  
  37.           _e_v_e_n_t__r_e_t_u_r_n
  38.                     Returns either a copy of or  the matched event's
  39.                     associated structure.
  40.  
  41.           _p_r_e_d_i_c_a_t_e Specifies the procedure that is to be called to
  42.                     determine if the next event in the queue matches
  43.                     what you want.
  44.  
  45.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  46.           The _X_I_f_E_v_e_n_t function completes only when the specified
  47.           predicate procedure returns _T_r_u_e for an event, which
  48.           indicates an event in the queue matches.  _X_I_f_E_v_e_n_t flushes
  49.           the output buffer if it blocks waiting for additional
  50.           events.  _X_I_f_E_v_e_n_t removes the matching event from the queue
  51.           and copies the structure into the client-supplied _X_E_v_e_n_t
  52.           structure.
  53.  
  54.           When the predicate procedure finds a match, _X_C_h_e_c_k_I_f_E_v_e_n_t
  55.           copies the matched event into the client-supplied _X_E_v_e_n_t
  56.           structure and returns _T_r_u_e.  (This event is removed from the
  57.           queue.)  If the predicate procedure finds no match,
  58.           _X_C_h_e_c_k_I_f_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have
  59.           been flushed.  All earlier events stored in the queue are
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXIIIIffffEEEEvvvveeeennnntttt((((3333XXXX11111111))))     XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))      XXXXIIIIffffEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           not discarded.
  75.  
  76.           The _X_P_e_e_k_I_f_E_v_e_n_t function returns only when the specified
  77.           predicate procedure returns _T_r_u_e for an event.  After the
  78.           predicate procedure finds a match, _X_P_e_e_k_I_f_E_v_e_n_t copies the
  79.           matched event into the client-supplied _X_E_v_e_n_t structure
  80.           without removing the event from the queue.  _X_P_e_e_k_I_f_E_v_e_n_t
  81.           flushes the output buffer if it blocks waiting for
  82.           additional events.
  83.  
  84.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  85.           XAnyEvent(3X11), XNextEvent(3X11), XPutBackEvent(3X11)
  86.           XSendEvent(3X11)
  87.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.